CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /Projects/{projectId}/runningStatus (Post)
In This Topic
    Post/Projects/{projectId}/runningStatus
    In This Topic
    Description
    start or stop a CIMPLICITY project
    Parameters
    NameDescriptionData Type
    projectIdthe id of the projectstring
    Request (application/json)

    The request body is of type object.

    Overview

    RunningStatus : CimRunningStatus
    DoConfigurationUpdate : boolean
    StartAtBoot : boolean
    200 Response

    The response body is of type ItemsPostResponse.

    At least one operation is successful, but at least one failed.

    Overview

    ItemsPostResponse
    The results of the create/update/delete operations.
    NumSuccesses : number
    NumFailures : number
    WarningsMask : integer
    ItemResults : Array[ItemResult]
    Success : boolean
    StatusDetails : integer
    WarningsMask : integer
    Message : string
    204 Response

    Project started or stopped successfully.
    Fault Responses
    FaultDescription
    404This fault returns a response body of type ProblemDetails.
    Error if object not found
    400This fault returns a response body of type .
    General error
    See Also
    All Operations Resource Group | CIMPLICITY Configuration REST API Web Service

     

     

    © 2024 GE Vernova and/or its affiliates. All rights reserved.

    Send comments on this topic.